Skip to main content

SignalResource

Description

call the SignalResource interface to send a signal.

Request Method

POST

Request Path

/apsara/route/ROS/SignalResource

Request Parameters Common Parameters

NameLocationTypeRequiredSample valueDescription
StatusBODYstringYesSUCCESSthe state of the signal. Failure signals will cause the resource stack to be unable to be created or updated. If all signals are warning signals, the resource stack cannot be created or updated. Value: SUCCESS FAILURE WARNING
UniqueIdBODYstringYes27c7347b-352a-4377-accf-63d361c1****unique ID of the signal. The length is 1 to 64 characters. If multiple signals are sent to a single resource (for example: signaling the waiting condition), each signal requires a different information ID.
LogicalResourceIdBODYstringYesWebServerresource logical ID, that is, the name of the resource in the template.
regionIdBODYstringYesNo sample value for this parameter.region id
RegionIdBODYstringYescn-hangzhouthe region ID to which the resource stack belongs.
ClientTokenBODYstringNo123e4567-e89b-12d3-a456-42665544****guarantees the idempotence of the request. This value is generated by the client and must be globally unique. is up to 64 characters in length and can contain English letters, numbers, dashes (-) and underscores (_).
versionBODYstringNo2016-01-01version of api
StackIdBODYstringYes4a6c9851-3b0f-4f5f-b4ca-a14bf691****resource stack ID.

Return data

NameTypeSample valueDescription
RequestIDstring1E3D5A1E0-67CA-43DA-24BC-EAF2D5A1E4DCRequest id

Example

Successful Response example

{
"RequestID":"1E3D5A1E0-67CA-43DA-24BC-EAF2D5A1E4DC"
}

Failed Response example

{
"errorSample":
{
"resultCode":-1,
"resultMsg":"system error",
"result":null
}

}